home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / sfmsl30.zip / SUPERFMS.DOC < prev    next >
Text File  |  1990-03-17  |  17KB  |  415 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11. ╔═══╗                       ╔════ ╔═╗╔═╗ ╔═══╗   ╗ 
  12. ║                           ║     ║ ║║ ║ ║       ║     Θ     ═╬═
  13. ╚═══╗ ╗  ╔ ╔══╗ ╔══╗ ╠══╗   ╠═══  ║ ╚╝ ║ ╚═══╗   ║     ╗ ╔══╗ ║   ╔══╗ ╠══╗
  14.     ║ ║  ║ ║  ║ ╠══╝ ║      ║     ║    ║     ║   ║     ║ ╚══╗ ║   ╠══╝ ║
  15. ╚═══╝ ╚══╩ ╠══╝ ╚══╝ ╝      ╝     ╝    ╚ ╚═══╝   ╚════ ╚ ╚══╝ ╚═╝ ╚══╝ ╝
  16.            ║
  17.            ╝
  18.                                  Version
  19.                                              
  20.                             ╔═════╗    ╔═════╗
  21.                                   ║    ║     ║
  22.                                ═══╣    ║     ║
  23.                                   ║ ╔╗ ║     ║
  24.                             ╚═════╝ ╚╝ ╚═════╝
  25.                                          
  26.  
  27.  
  28.                                 Written By
  29.  
  30.                                 Ethan Poole
  31.  
  32.  
  33.  
  34.                                P.O. Box 1090
  35.                           Trenton, FL  32693-1090
  36.                           [voice]  (904) 463-6108
  37.  
  38.                          The EHP Software Exchange
  39.                            [data] (904) 463-0027
  40.                             300/1200/2400  Baud
  41.                               24 hrs,  7-days
  42.  
  43.  
  44.  
  45.  
  46.                           ╔═══════════════════════╗
  47.                           ║  3.0  March 17, 1990  ║
  48.                           ╚═══════════════════════╝
  49.  
  50.                              2.0  November 16, 1989
  51.                              1.5  October 16, 1989
  52.                              1.0  September 15, 1989
  53. This Program Consists of the Following Files:
  54.  
  55.    o  SUPERFMS.EXE --- The Executable File
  56.                              (Compiled with QuickBASIC 4.5)
  57.  
  58.    o  SUPERFMS.DOC --- This Text File!
  59.  
  60.    o  REGISTER.NOW --- Super FMS Lister 3.0 Registration Form
  61.  
  62. If you do not have all of the above files, please download the latest
  63. version from my board at [data] (904) 463-0027, 24-hours a day.
  64.  
  65. This utility was originally designed because I could find no other
  66. utility programs which could handle my own particular needs in the way
  67. I wanted.  If you have needs above and beyond what this utility can
  68. presently handle, please see the section on REQUESTING ADDITIONAL
  69. FEATURES.
  70.  
  71.  
  72. Purpose:
  73. ========
  74.  
  75. The purpose of the Super FMS Lister is to take your rather random
  76. (although often chronologically or alphabetically ordered) FMS Master
  77. Directory and make a nice, sorted, organized, and classified listing of
  78. ALL your BBS's files.  A list of this nature is just perfect for your
  79. users to download, print out, and select which files they want before
  80. they spend valuable time online your BBS!  A list such as this could
  81. improve your BBS usage, mainly because people can select all the files
  82. that seem interesting to them at their leisure without the hurry of
  83. trying to find the same files online with your BBS.  No longer will
  84. users have to perform a Screen Capture to make a record of available
  85. files on your BBS, now they can simply download a single file and have
  86. a complete listing!
  87.  
  88.  
  89. Limitations:
  90. ============
  91.  
  92.    o  Does not support Chained FMS Master Directories
  93.  
  94.    o  Does not handle RBBS's special file security feature (i.e 
  95.       '=filename.zip ... 10DescriptionXXX'; meaning that the file is
  96.       only viewable and downloadable to those with a security level of
  97.       10 or greater)
  98.  
  99.    o  No single category can exceed 10,000 lines (I refer to these 
  100.       categories as Psuedo-Directories).  Hey...if you have more than
  101.       151 pages worth of files listed in a single category, maybe you 
  102.       should break it up into two categories!
  103.  
  104.    o  Requires additional work space on your hard disk (requires about
  105.       40-50% of the space used by your FMS Master Directory to be free)
  106.  
  107.    o  Requires 170+KB free for a Non-Sorted listing, 330+KB if Sorted
  108.  
  109.    o  Directory Name (from DIR.CAT) must not exceed 12 characters
  110.       in length
  111.  
  112.    o  Directory Descriptions (from DIR.CAT) must not exceed 62
  113.       characters in length
  114.  
  115.    o  ALL lines in your DIR.CAT file MUST be VALID, LEGAL, entries!
  116.       (i.e. "GAMES","MNO,CGA,EGA,VGA,SGA","Games of all sorts!")
  117.  
  118.    o  No single EXTENDED DESCRIPTION may exceed 23 lines in length
  119.       Hey, I think one full screen should be enough to describe a file!
  120.  
  121.    o  Can't handle a "\FMS TOP" command if you use extended
  122.       descriptions
  123.  
  124.  
  125. Features:
  126. =========
  127.  
  128.    o  Built in support for multiple category codes within each category
  129.       (i.e.  "GAMES","MNO,CGA,EGA,VGA,SGA","Games of all sorts!" vs.
  130.       "GAMES","GAM","Games of all sorts!")
  131.  
  132.    o  Doesn't print SysOp-Only Comments/Descriptions (those beginning
  133.       with a '/....')
  134.  
  135.    o  Doesn't print comment lines (those beginning with an '*...')
  136.  
  137.    o  A little bit faster in initial sorting than 2.0 on cached
  138.       systems, significantly faster on non-cached systems.  
  139.       (Note:  Use of a hard disk cache is HIGHLY recommended!)
  140.  
  141.    o  By using multiple configuration files, you can create multiple
  142.       lists with multiple formats.  (i.e. one sorted by date, the other
  143.       sorted alphabetically)
  144.  
  145.    o  Excellent on-line help when you encounter errors within this
  146.       program.  States problem.  Often will suggest cause and
  147.       appropriate action to take!
  148.  
  149.    *  Allows Standard and Reverse Sorting Alphabetically by File Name
  150.  
  151.    *  Allows Standard and Reverse Sorting by File Date with a Secondary
  152.       sort by File Name
  153.  
  154.    *  Allows for Re-Formatting of your FileNames in three different
  155.       ways, plus option to leave as-is:
  156.          By <D>ot ------------------------> FILE.EXT
  157.          By Extension <A>lignment --------> FILE     EXT
  158.          By doing <B>oth -----------------> FILE    .EXT (my favorite!)
  159.          By <U>nadjusted (leave as-is) ---> [same as in FMS Master Dir]
  160.  
  161.    *  Allows for user to add a Comments file to the Top and/or Bottom
  162.       of their listing!
  163.  
  164. NOTE:  ALL FEATURES PRECEDED BY AN '*'  are available only to
  165.        registered users.  Read on or see Registration form for
  166.        more details!
  167.  
  168.  
  169. DOS Command Line Usage:
  170. =======================
  171.  
  172. USAGE:  [d:\path\]SUPERFMS [d:\path\config.fil] [/R]
  173.  
  174. where optional parameter [d:\path\config.fil] is the Drive, Path, and
  175. File Name containing the Configuration data for SUPERFMS.  If no
  176. optional parameters are entered, the default configuration file is
  177. SMFSL.CFG in the present directory
  178.  
  179. optional parameter [/R] (upper or lower case) indicates that you wish
  180. to re-configure Super FMS Lister.  It will use SFMSL.CFG as the
  181. configuration file if no alternate name is requested.  (NOTE: SUPERFMS
  182. now supports both commands simultaneously and in any order -- separate
  183. with a space)
  184.  
  185.  
  186. First Time:
  187. ===========
  188.  
  189. Install SUPERFMS.EXE in your RBBS or UTILITIES Directory (although can
  190. be any directory you choose).  Please note that you should store the
  191. configuration file in the directory you plan to run SUPERFMS from,
  192. unless you intend to make use of the command line option which allows
  193. you to select an alternate path and/or filename.
  194.  
  195.  EXAMPLE SETUP:
  196. =======================================================================
  197.  
  198.              Filename and path for FMS master DIR: C:\RBBS\MASTER.DIR
  199.              Filename and path for DIR categories: C:\RBBS\DIR.CAT
  200.     Output Filename and path for Sorted Directory: C:\GENERAL\EHP-LIST
  201.    Maximum 'Depth' of Category Codes (normally 1): 1
  202.        Your BBS's Name (up to 77 characters long): The EHP Soft Xchg
  203.       Sort By: <D>ate, <Alphabetically, <N>o Sort: A
  204.                     Perform a REVERSE Sort (Y/N)?: N
  205.   Format for Filenames:  <A>ligned - FILENAME EXT; 
  206.   <D>otted - FILENAME.EXT;  <B>oth;  <U>nadjusted: B
  207.    Path and Filename for OPTIONAL Comments at Top: C:\RBBS\TOP.TXT
  208. Path and Filename for OPTIONAL Comments at Bottom: C:\RBBS\BOTTOM.TXT
  209.     Path to PKZIP, if you wish it to ZIP the List: C:\UTILS
  210.   If a REGISTERED USER, input your REGISTRATION #: [reg #]
  211. Is all information correct (Y/N)?  Y <enter>
  212.  
  213. =======================================================================
  214.  
  215. THE MAXIMUM 'DEPTH' OF CATEGORY CODES QUESTION refers to how deep your
  216. category codes are.  For example, in the following situation (in your
  217. DIR.CAT file) you would enter a:
  218.                       '3'
  219.                      / | \
  220.                     /  |  \
  221.       "SPRD_SHT","LTS,PPS,OTS","Spread Sheets and/or Utils/Macros"
  222.       "AI","AI","Software to make your PC Artificially Smart!"
  223.  
  224. You should now see the Intro Screen, it lasts about 10 seconds and is
  225. followed by a status screen showing you Super FMS Lister in action!
  226.  
  227. NOTE:  The value displayed for "Line Count = xxxx" should NEVER exceed
  228.        the value displayed for "Max Number of Lines = xxxx".  If this
  229.        does ever occur, an appropriate error message will be displayed.
  230.        You should remedy this by splitting your larger psuedo-
  231.        directories into two or more new and smaller psuedo-directories.
  232.  
  233.  
  234. Using an Editor to Edit the Configuration File:
  235. ===============================================
  236.  
  237. The configuration file is set up in such a way as to facilitate editing
  238. with most any type of editor -- especially a line editor.  For those of
  239. you wishing to edit the configuration file in such a manner, here is
  240. the format of the file:
  241.  
  242. Line 1  <---Version ID (DON'T ALTER!)
  243. Line 2  <---Drive, Path, and File Name for FMS Master Dir
  244. Line 3  <---Drive, Path, and File Name for DIR.CAT file
  245. Line 4  <---Max Depth of Cat Codes (usually 1, max of 32,767)
  246. Line 5  <---Drive, Path, and File Name for Output Listing
  247. Line 6  <---Your BBS Name (up to 77 characters)
  248. Line 7  <---Type of Sort: <A>lpha, <D>ate, <N>one
  249. Line 8  <---Do a REVERSE Sort? ( Y or N )
  250. Line 9  <---File Name Format: <D>otted, <A>ligned, <B>oth, <U>nadjusted
  251. Line 10 <---Drive, Path, and File Name for TOP COMMENTS [or blank]
  252. Line 11 <---Drive, Path, and File Name for BOTTOM COMMENTS [or blank]
  253. Line 12 <---Drive and Path to PKZIP (blank if you don't want it ZIPped)
  254. Line 13 <---Registration # [or blank if unregistered]
  255.  
  256.  
  257. HyperSort -- What does that funny little flashing message mean?
  258. ===============================================================
  259.  
  260. HyperSort was introduced with version 2.0 and has proven an excellent
  261. means of getting the job done quickly and easily.  With HyperSort,
  262. SUPERFMS takes one look at your FMS Master Directory File and copies
  263. the byte location of the first character of every line to a temporary
  264. file based upon the line's category code.  It then loads in these
  265. workfiles one at a time, copying their values to a long integer (4
  266. byte) array of 10,000 elements.  It then starts counting down from the
  267. last element containing a value to the very first element in the array,
  268. all the while referencing the FMS Master Directory File [based on the
  269. byte locations retrieved] and getting each line of text needed to
  270. construct the final formatted listing.
  271.  
  272. HyperSort was really a brand new twist to my program.  Unlike versions
  273. prior to 2.0, you could now sort any list in an environment of 170+KB. 
  274. Additionally, it does so at an incredible speed of 200% faster than
  275. versions 1.0 and 1.5!  As if that weren't enough, I've speeded up the
  276. initial breakdown sort even further in version 3.0!  It gives your hard
  277. drive a little bit of a workout, but it's fast!
  278.  
  279.  
  280. Requesting Additional Features:
  281. ===============================
  282.  
  283. If Super FMS Lister doesn't quite fit your needs then I would greatly
  284. appreciate it if you would leave me a message on my BBS stating exactly
  285. what it is you want.  For reference purposes, you should also upload
  286. the following files to me:  your MASTER.DIR file, DIR.CAT file, and
  287. your SFMSL.CFG configuration file.  Priority is given to Registered
  288. users, but all reasonable requests will be considered.
  289.  
  290. On the other hand, if Super FMS Lister sounds like something you need
  291. or want but just doesn't seem to work at all (namely if you are using
  292. the '\FMS TOP' or Chained Directories) PLEASE DON'T ABANDON ALL HOPE! 
  293. As much as I would like to make Super FMS Lister Compatible with all
  294. formats, user input has left much to be desired and I haven't had the
  295. time to try to create a dozen different versions of my own MASTER.DIR
  296. and DIR.CAT files. However, if you will upload your MASTER.DIR file(s)
  297. and DIR.CAT file(s), I will give VERY serious consideration to
  298. integrating your requests into [any] future releases.  I do need some
  299. help from you though.  Please call back about a week after leaving me
  300. such a request/complaint to check on the status of your suggestion. 
  301. Hopefully I will have a beta version incorporating your suggestions
  302. ready for you to try.  Please understand that, because of the diversity
  303. of RBBS setups, beta testing is very important.  Besides, a person like
  304. me needs all the help they can get <I really do>!!!  Naturally, your
  305. suggestions will receive top priority, regardless of your Registration
  306. status -- I can't exactly expect you to register a program BEFORE it
  307. even works properly for you!!!
  308.  
  309.  
  310. Questions, Comments, and Error Reports:
  311. =======================================
  312.  
  313. All Questions, Comments, and Error Reports concerning Super FMS Lister
  314. should be directed to Ethan Poole.
  315.  
  316.     o  [voice] (904) 463-6108; evenings and weekends (all returned
  317.        calls will be collect!  Sorry, but I can't afford the bills
  318.        as-is!)
  319.  
  320.     o  [data] (904) 463-0027; 24-hours, 7-days; 300/1200/2400 Baud 8n1
  321.  
  322.     o  or by FAX (904) 463-7666 (ATTN:  ETHAN POOLE)
  323.  
  324. NOTE: If you are reporting an error or bug, please upload your
  325.       MASTER.DIR, DIR.CAT, SFMSL.CFG [and if it is visible in
  326.       your SuperFMS generated list, your file list] to my bbs
  327.       along with a text file or message documenting the problem
  328.       so that it may be corrected in future releases!  THANKS!
  329.  
  330.  
  331. Concerning Registration:
  332. ========================
  333.  
  334. WARNING...THIS DOCUMENTATION WILL SELF-DESTRUCT IN 5 SECONDS IF YOU DO
  335. NOT READ THE FOLLOWING STATEMENTS!!!
  336. .........
  337. well, maybe nothing quite that exciting, but please do read the
  338. following!
  339.  
  340. Well, I didn't want to have to do it.  Lack of registered users (and a
  341. dire need for a new hard disk on my BBS) has forced me to ENFORCE
  342. REGISTRATION!!!  The Sort, File Name Formatting, and Top/Bottom Comment
  343. features are disabled to all un-registered users.
  344.  
  345. If you are an unregistered user, this version is probably little more
  346. than a somewhat souped-up version of 2.0....
  347.  
  348. ...On the other hand.  If you are a REGISTERED USER, Super FMS Lister
  349. is now more powerful than ever!  You now have the option to Sort your
  350. directories, change the format of your printed file names, and the very
  351. useful capability of including a text file(s) at the top and/or bottom
  352. of your Super FMS Lister generated listing!!!
  353.  
  354. I didn't want to have to cripple the software, but it was really forced
  355. upon me.  As such, I've designed things so that REGISTERED users will
  356. receive a minimal hassle from this scheme.
  357.  
  358. Registration of Super FMS Lister is a one time only deal.  Your
  359. password will work for this version as well as all future versions
  360. without your having to re-register.  In addition, the publicly
  361. distributed version is the only version you need.  You do not have to
  362. donwload a special version from me, nor do you need to worry about
  363. making any sort of patch to the software.  Your registration # is your
  364. key and it will work on this and ALL future versions!!!
  365.  
  366. Here is my registration RATES CHART:
  367.  
  368.      BASIC REGISTRATION:     $15  ($20 if you really like it) REQUIRED
  369.  
  370.      MAIL NOTIFICATION OF
  371.           NEW VERSIONS:       $1  <---one time fee
  372.           (new version
  373.           always avlbl
  374.           on my BBS!)
  375.  
  376.      RECEIVE LATEST VERSION
  377.        ON DISK BY MAIL:       $5  <--FIRST CLASS, not a one time fee
  378.                                                                 /\
  379.        RECEIVE QB 4.0-4.5                                        |
  380.            SOURCE CODE:       $5  <--only $2 if ordered w/ above--
  381.      ====================== =====
  382.      Cost if you want the
  383.         works!!!             $23  <--if you would like to donate 
  384.                                    towards my purchase of a new hard
  385.                                    disk, add any additional donations.
  386.                                    <that would sure make my day!>
  387.  
  388. NOTE:  Your REGISTRATION #, and Source Code (if you select that option)
  389.        are yours and yours only.  They are not to be distributed to
  390.        others as they are for your own personal use!!!
  391.  
  392. *****THANKS FOR YOUR REGISTRATION...I REALLY DO NEED THE HELP!!!*****
  393. Like I said, all money received will be put into improving my bbs and
  394. into the development of other projects such as this.  
  395.  
  396.  
  397. Additional RBBS Utilities:
  398. ==========================
  399.  
  400. I am also the author of the following RBBS Utilities:
  401.  
  402.     o  FMS CHECKER [FMSCKxx]  <--3.0 to be released soon!
  403.  
  404.     o  Page Lister [PGLISTxx] <--to be released soon, companion util to
  405.                                  Super FMS Lister!
  406.  
  407.  
  408.                        Thanks for Your Interest!
  409.                        =========================
  410.  
  411.  P.S. -- Why don't you give the EHP Software Exchange a Try!
  412.          Dial (904) 463-0027 (3/12/2400 BPS) TODAY!!!
  413.  
  414. ehp/03/17/90
  415.